<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>is_partitioned</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost Algorithm Library">
<link rel="up" href="../../algorithm/CXX11.html" title="C++11 Algorithms">
<link rel="prev" href="is_sorted.html" title="is_sorted">
<link rel="next" href="is_permutation.html" title="is_permutation">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="is_sorted.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_permutation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="the_boost_algorithm_library.CXX11.is_partitioned"></a><a class="link" href="is_partitioned.html" title="is_partitioned">is_partitioned
      </a>
</h3></div></div></div>
<p>
        The header file 'is_partitioned.hpp' contains two variants of a single algorithm,
        <code class="computeroutput"><span class="identifier">is_partitioned</span></code>. The algorithm
        tests to see if a sequence is partitioned according to a predicate; in other
        words, all the items in the sequence that satisfy the predicate are at the
        beginning of the sequence.
      </p>
<p>
        The routine <code class="computeroutput"><span class="identifier">is_partitioned</span></code>
        takes a sequence and a predicate. It returns true if the sequence is partitioned
        according to the predicate.
      </p>
<p>
        <code class="computeroutput"><span class="identifier">is_partitioned</span></code> come in two
        forms; the first one takes two iterators to define the range. The second
        form takes a single range parameter, and uses Boost.Range to traverse it.
      </p>
<h5>
<a name="the_boost_algorithm_library.CXX11.is_partitioned.h0"></a>
        <span class="phrase"><a name="the_boost_algorithm_library.CXX11.is_partitioned.interface"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.interface">interface</a>
      </h5>
<p>
        The function <code class="computeroutput"><span class="identifier">is_partitioned</span></code>
        returns true if the items in the sequence are separated according to their
        ability to satisfy the predicate. There are two versions; one takes two iterators,
        and the other takes a range.
      </p>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicate</span><span class="special">&gt;</span>
	<span class="keyword">bool</span> <span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="identifier">InputIterator</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">InputIterator</span> <span class="identifier">last</span><span class="special">,</span> <span class="identifier">Predicate</span> <span class="identifier">p</span> <span class="special">);</span>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Predicate</span><span class="special">&gt;</span>
	<span class="keyword">bool</span> <span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&amp;</span><span class="identifier">r</span><span class="special">,</span> <span class="identifier">Predicate</span> <span class="identifier">p</span> <span class="special">);</span>
</pre>
<p>
      </p>
<h5>
<a name="the_boost_algorithm_library.CXX11.is_partitioned.h1"></a>
        <span class="phrase"><a name="the_boost_algorithm_library.CXX11.is_partitioned.examples"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.examples">Examples</a>
      </h5>
<p>
        Given the container <code class="computeroutput"><span class="identifier">c</span></code> containing
        <code class="computeroutput"><span class="special">{</span> <span class="number">0</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span>
        <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">14</span><span class="special">,</span> <span class="number">15</span> <span class="special">}</span></code>,
        then
</p>
<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">isOdd</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special">%</span> <span class="number">2</span> <span class="special">==</span> <span class="number">1</span><span class="special">;</span> <span class="special">}</span>
<span class="keyword">bool</span> <span class="identifier">lessThan10</span> <span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">i</span> <span class="special">&lt;</span> <span class="number">10</span><span class="special">;</span> <span class="special">}</span>

<span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">,</span> <span class="identifier">isOdd</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="keyword">false</span>
<span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">,</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="keyword">true</span>
<span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="keyword">true</span>
<span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">begin</span> <span class="special">()</span> <span class="special">+</span> <span class="number">3</span><span class="special">,</span> <span class="identifier">lessThan10</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="keyword">true</span>
<span class="identifier">is_partitioned</span> <span class="special">(</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">c</span><span class="special">.</span><span class="identifier">end</span> <span class="special">(),</span> <span class="identifier">isOdd</span> <span class="special">)</span> <span class="special">--&gt;</span> <span class="keyword">true</span>  <span class="comment">// empty range</span>
</pre>
<p>
      </p>
<h5>
<a name="the_boost_algorithm_library.CXX11.is_partitioned.h2"></a>
        <span class="phrase"><a name="the_boost_algorithm_library.CXX11.is_partitioned.iterator_requirements"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.iterator_requirements">Iterator
        Requirements</a>
      </h5>
<p>
        <code class="computeroutput"><span class="identifier">is_partitioned</span></code> works on all
        iterators except output iterators.
      </p>
<h5>
<a name="the_boost_algorithm_library.CXX11.is_partitioned.h3"></a>
        <span class="phrase"><a name="the_boost_algorithm_library.CXX11.is_partitioned.complexity"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.complexity">Complexity</a>
      </h5>
<p>
        Both of the variants of <code class="computeroutput"><span class="identifier">is_partitioned</span></code>
        run in <span class="emphasis"><em>O(N)</em></span> (linear) time; that is, they compare against
        each element in the list once. If the sequence is found to be not partitioned
        at any point, the routine will terminate immediately, without examining the
        rest of the elements.
      </p>
<h5>
<a name="the_boost_algorithm_library.CXX11.is_partitioned.h4"></a>
        <span class="phrase"><a name="the_boost_algorithm_library.CXX11.is_partitioned.exception_safety"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.exception_safety">Exception
        Safety</a>
      </h5>
<p>
        Both of the variants of <code class="computeroutput"><span class="identifier">is_partitioned</span></code>
        take their parameters by value or const reference, and do not depend upon
        any global state. Therefore, all the routines in this file provide the strong
        exception guarantee.
      </p>
<h5>
<a name="the_boost_algorithm_library.CXX11.is_partitioned.h5"></a>
        <span class="phrase"><a name="the_boost_algorithm_library.CXX11.is_partitioned.notes"></a></span><a class="link" href="is_partitioned.html#the_boost_algorithm_library.CXX11.is_partitioned.notes">Notes</a>
      </h5>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
            The iterator-based version of the routine <code class="computeroutput"><span class="identifier">is_partitioned</span></code>
            is also available as part of the C++11 standard.
          </li>
<li class="listitem">
            <code class="computeroutput"><span class="identifier">is_partitioned</span></code> returns
            true for empty ranges, no matter what predicate is passed to test against.
          </li>
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2010-2012 Marshall Clow<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="is_sorted.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../algorithm/CXX11.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_permutation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
